Skip to content

docs: rename quick-start to get-started and fix sidebar overflow#196

Open
giwaov wants to merge 2 commits into0xMiden:mainfrom
giwaov:docs/rename-quickstart-to-getstarted-191
Open

docs: rename quick-start to get-started and fix sidebar overflow#196
giwaov wants to merge 2 commits into0xMiden:mainfrom
giwaov:docs/rename-quickstart-to-getstarted-191

Conversation

@giwaov
Copy link

@giwaov giwaov commented Mar 9, 2026

Summary

This PR addresses two documentation issues:

Issue #191: Rename quick-start to get-started

Renamed 'Quick Start' section to 'Get Started' to align with naming conventions used by other protocols (Aptos, Sui, Starknet).

Changes:

  • Renamed \docs/builder/quick-start/\ \docs/builder/get-started/\
  • Renamed \�ersioned_docs/version-0.13/builder/quick-start/\ \get-started/\
  • Updated all _category_.json\ files with new labels and doc IDs
  • Updated \sidebars.ts\ with new paths
  • Updated all internal links across:
    • \docs/builder/index.md\
    • \docs/core-concepts/index.md\
    • \docs/builder/migration/index.md\
    • \docs/builder/tutorials/rust-compiler/*.md\
    • \static/llms.txt\
    • \CLAUDE.md\
    • \README.md\
  • Added redirects in \docusaurus.config.ts\ for backward compatibility:
    • /quick-start/\ /builder/get-started/\
    • /builder/quick-start/\ /builder/get-started/\

v0.11 and v0.12 snapshots left unchanged (historical).

Issue #170: Sidebar CSS overflow for long titles

Long titles in the smart-contracts section were overflowing the sidebar container.

Changes (src/custom/_sidebar.css):

  • Added \overflow-x: hidden\ to sidebar container and menu
  • Category labels truncate with ellipsis (single line)
  • Leaf item links wrap naturally for better readability
  • Code elements in sidebar use \�reak-all\ to prevent overflow
  • Added \word-wrap, \overflow-wrap\ and \hyphens\ for graceful text handling

Test Plan

  • Build passes with
    pm run build\
  • Redirects work for old quick-start URLs
  • Sidebar displays correctly with long titles
  • All internal links resolve correctly

Fixes #191
Fixes #170

giwaov added 2 commits March 9, 2026 08:52
Fixes 0xMiden#191

Renamed 'Quick Start' section to 'Get Started' to align with naming conventions
used by other protocols (Aptos, Sui, Starknet).

Changes:
- Renamed docs/builder/quick-start/ to docs/builder/get-started/
- Renamed versioned_docs/version-0.13/builder/quick-start/ to get-started/
- Updated all _category_.json files with new labels and doc IDs
- Updated sidebars.ts with new paths
- Updated all internal links in:
  - docs/builder/index.md
  - docs/core-concepts/index.md
  - docs/builder/migration/index.md
  - docs/builder/tutorials/rust-compiler/*.md
  - static/llms.txt
  - CLAUDE.md
  - README.md
- Added redirects in docusaurus.config.ts for:
  - /quick-start/* -> /builder/get-started/*
  - /builder/quick-start/* -> /builder/get-started/*

v0.11 and v0.12 snapshots left unchanged (historical).
Fixes 0xMiden#170

Long titles in the smart-contracts section (e.g., 'Cross-Component Calls',
'Toolchain & Project Structure', 'Patterns & Security') were overflowing
the sidebar container.

Changes:
- Added overflow-x: hidden to sidebar container and menu
- Category labels now truncate with ellipsis (single line)
- Leaf item links wrap naturally for better readability
- Code elements in sidebar break-all to prevent overflow
- Added word-wrap, overflow-wrap and hyphens for graceful text handling
@giwaov giwaov force-pushed the docs/rename-quickstart-to-getstarted-191 branch from b2ed5ec to 7032873 Compare March 9, 2026 07:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sidebar styling: long titles overflow in smart-contracts section docs: rename quick-start to get-started

1 participant